************

INTRODUCTION

************


This file describes how to set up and use the Java wrapper code for Melissa DATA's Address Object.

*************

PREREQUISITES

*************


To make use of the Address Object Java wrapper you will need:


* An installation of a Java Developer's Kit 1.4.2 or later or an equivalent product.


* The Melissa DATA Address Object library and data files installed.


	Library = libmdAddr.so

	Data Files = mdAddr.dat, mdAddr.nat, mdAddr.str, mdAddr.lic


  These files are installed automatically if you run setup.sh. 


You will need to know the location of these items in order to install and run the Java wrapper.


**********************
Wrapper compatibility
**********************

If the provided pre-compiled wrappers are not compatible with your environment, the necessary files for compilation can be found in the 'interfaces' folder of the object's main directory.


*************

Installation

*************


Copy the entire folder that contains this README.txt into a local directory on your computer.



*****

Setup

*****


Open BuildWrapper.sh. Put the path of the installed Address Object library files into mdAddrPath.


	declare -r mdAddrPath="The Path To Your AddrObj Directory"


Also, make sure  your JAVA_HOME enviornment variable is set:


	ex: export JAVA_HOME=/usr/lib/jvm/jdk1.6


Open RunSample.sh. Put the path of the directory containing libmdAddr.so into AddrLibraryPath.


	ex: AddrLibraryPath=/DQT/Current


Also, set the Address Object License string that you receive from your Melissa Data sales representative as 

well as the directory of the Address Object data files in the sample java code AddressSample.java.

	ex: LicenseString="LICENSE"

	DataPath="/DQT/Current"



*******************

Running the Scripts

*******************


1. Execute BuildWrapper.sh (sh BuildWrapper.sh). This should create a file name libmdAddrJavaWrapper.so and mdAddr.jar. These files must be created successfully to proceed.

   A 32bit pre-compiled version of libmdAddrJavaWrapper.so and mdAddr.jar files are included in the x86 directory. To use them, copy the files into the main directory containing RunSample.sh.


2. Execute RunSample.sh (sh RunSample.sh). This will compile AddressSample.java and ParseZipStreetSample.java. Only AddressSample.java will be run. To use ParseZipStreetSample, you can change RunSample.sh.



***********

Sample Code

***********


AddressSample.java contains sample code for using Address Object.

If you make changes to AddressSample.java, you must execute RunSample.sh again to recompile the code.


Now you can build your program, set your environment variables and command lines 

(using the shell scripts as a guideline) and you're ready to go.


*******

Updates

*******


libmdAddrJavaWrapper.so and mdAddr.jar built by BuildWrapper.sh do not need to be re-built for every single update. For normal updates, simply replacing libmdAddr.so and the data files are enough. However, if there is a change in libmdAddr.so like a new method, you will need to rebuild the wrapper to use the new method. 


COPYRIGHT NOTICE


(C) 2014 Melissa Data Corporation. All rights reserved.

